home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / usenet / sources / volume90 / util / wrap_1.00 / Wrap.doc < prev    next >
Text File  |  1990-03-04  |  3KB  |  56 lines
  1.      Wrap V1.00 is Copyright (c)1990 by Dave Schreiber.  All rights reserved. 
  2. This program is freely distributable, and may not be sold.  Money may be
  3. charged for copying, media, shipping/handling, labels, taxes, and related
  4. costs.
  5.  
  6.      Wrap is a simple text formatter designed to word-wrap text files that
  7. have no carriage returns in paragraphs.  I wrote it because my word
  8. processor, Write & File (never heard of it?  Imagine a scaled down version
  9. of Pen Pal, written by Pen Pal's author), when it saves a document as
  10. straight ASCII, only has carriage returns at the end of paragraphs.  This is
  11. nice when I import something into a desktop publishing program, but not when
  12. I use Write & File to write program documentation such as the documentation
  13. you're reading now.  I could insert carriage returns manually, but that's a
  14. lot of work for 3 page docs, and if I make one change in the documentation,
  15. I have to reformat the whole thing over again.
  16.  
  17.      But enough of justifying Wrap's existence.  Wrap's command line should
  18. look like this:
  19.  
  20.        1> Wrap [options] <infile> <outfile>
  21.  
  22. <infile> is the name of the unformatted text and <outfile> is the filename
  23. you want the formatted text saved under.  The options are:  
  24.  
  25.        -a# -- expand TABs out # spaces (default:  5 spaces)
  26.        -b# -- set a bottom margin of # (default:  0)
  27.        -t# -- set a top margin of # (default:  0)
  28.        -r# -- set a right margin of # (default:  0)
  29.        -l# -- set a left margin of # (default:  0)
  30.        -i# -- number of spaces to indent each paragraph
  31.               (default:  0)
  32.        -p# -- number of lines in a page (default:  66)
  33.        -d  -- use double spacing (single spacing is the 
  34.               default)
  35.  
  36. The line width is set at 79 characters.  To format a text file to fit into a
  37. CLI window, I'd recommend a right margin of two.  If you want to send the
  38. file to a printer, set the bottom and top margins to suit the printer.  If
  39. the printer supports less or more than 66 lines per page, -p lets you set
  40. that.  If you forgot to indent your paragraphs, -i will let you set that. 
  41. If you indent them with TABs, -a will let you control how many spaces are
  42. inserted in place of a TAB.
  43.  
  44.      That's it.  Any questions, comments, praise, etc. should be sent to the
  45. e-mail address(es) below.  Enjoy.
  46.  
  47. -Dave Schreiber
  48. davids@slugmail.ucsc.edu (prefered, but flakey.  If it doesn't work, try:
  49. davids@ucscb.ucsc.edu (school year)
  50. davids@cup.portal.com (summer, vacations, etc.))
  51.  
  52. P.S.  Just to give you something to experiment with, I've included the
  53. unformatted version of this documentation under the name "Wrap.unfmt".
  54.  
  55.  
  56.